Correct the documentation. Patch by Paul Davis

        * gdk/gdkdisplay.c (gdk_display_get_window_at_pointer): Correct
        the documentation. Patch by Paul Davis

svn path=/trunk/; revision=21852

diff --git a/ChangeLog b/ChangeLog
index d4e0f12549f983c9afb6ac12a390890cba0b9731..4ee30d116d68f76c2b68da5d4bb8b81a9bd6eb77 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2008-12-07  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 559325 – documentation for gdk_display_get_window_at_pointer() 
+       is wrong
+
+       * gdk/gdkdisplay.c (gdk_display_get_window_at_pointer): Correct
+       the documentation. Patch by Paul Davis
+
 2008-12-07  Matthias Clasen  <mclasen@redhat.com>
 
        Bug 563285 – test print backend does not compile

diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c
index 2b163de635176509f1193ddd6b40641753e8b2a8..9417c4e9475b2bb7d6846fbd2db72e59b3cd3350 100644 (file)
--- a/gdk/gdkdisplay.c
+++ b/gdk/gdkdisplay.c
@@ -476,13 +476,15 @@ gdk_display_get_pointer (GdkDisplay      *display,
 /**
  * gdk_display_get_window_at_pointer:
  * @display: a #GdkDisplay
- * @win_x: return location for origin of the window under the pointer
- * @win_y: return location for origin of the window under the pointer
+ * @win_x: return location for x coordinate of the pointer location relative 
+ *    to the window origin, or %NULL
+ * @win_y: return location for y coordinate of the pointer location relative
+ &    to the window origin, or %NULL
  * 
  * Obtains the window underneath the mouse pointer, returning the location
- * of that window in @win_x, @win_y for @screen. Returns %NULL if the window 
- * under the mouse pointer is not known to GDK (for example, belongs to
- * another application).
+ * of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL 
+ * if the window under the mouse pointer is not known to GDK (for example, 
+ * belongs to another application).
  * 
  * Returns: the window under the mouse pointer, or %NULL
  *